home *** CD-ROM | disk | FTP | other *** search
/ Amiga Aktuell / Amiga Aktuell.iso / amiga-aktuell / net tools / bbs / amiexpress bbs / warps_23 / warpsearch.doc < prev    next >
Text File  |  1996-09-05  |  7KB  |  189 lines
  1. WarpSearch V2.3
  2.  
  3.  
  4. Introduction
  5. ------------
  6. This is the AmiExpress version of WarpSearch.
  7. It uses the boyer-moore search algorithm implemented in assembler code.
  8. This algorithm is the fastest available.
  9.  
  10.  
  11. Features
  12. --------
  13. V1.0:
  14. -pattern matching
  15. -asynchonous I/O
  16. -backwards/forwards counting of filelists
  17. -highlightning
  18.  
  19. V2.0:
  20. -now real reverse search (search code / buffer loading / dir counting)
  21. -residentable
  22. -DMA optimized
  23. -prompts always behind complete descriptions
  24. -simple flagging, also "f file1.lha f file2.lha"
  25. -ndirs file is used to be s-express compatible if no ndirs tooltype exists
  26. -colors for the description output
  27. -configurable via tooltypes (of the WarpSearch executable) or WarpSearch.config file
  28.  tooltypes override file config
  29.  
  30. V2.1:
  31. -bugfixed V2.0
  32.  If there were escape codes in the text of a file description the line was
  33.  repeated in an infinite loop but you were able to quit the program at the
  34.  prompt. No memory trashes or similar occured. This is fixed now. A harmless
  35.  byte read from adress 0 in the shell version was wiped out too.
  36.  
  37. V2.3:
  38. -added prompts if no args at start specified in bbs version
  39. -speedup due to asm code improvement and faster resource allocations (unbelieveable but true)
  40. -wildcard problem fixed
  41. -help rewritten
  42.  
  43. Installation
  44. ------------
  45. Copy "z.info" to "bbs:commands/bbscmd/".
  46. Change LOCATION to your full path of the WarpSearch executable.
  47. Adjust configuration if you like.
  48.  
  49.  
  50. Usage
  51. -----
  52. compatible to /X z door
  53.  
  54. z <pattern> <filelist#> <+/-/r>
  55.  
  56. Example usage:
  57. "z foo"      (searches in upload dir for "foo" forwards).
  58. "z foo r"    (searches in upload dir reverse).
  59.  
  60. "z foo 3 r"  (searches in dir3 reverse).
  61. "z foo a +"  (searches from dir1 up for "foo").
  62.  
  63. "z foo a -"  (searches from upload dir down for "foo").
  64. "z foo 2 +"  (searches from dir2 up for "foo").
  65. "z foo 1"    (searches dir1 only for "foo").
  66.  
  67. Wildcards in pattern are allowed, like "z foo*bar" or "z warp*V1.0*"
  68. Use "z foo*bar 2 +" to search from dir2 upwards. Default is downwards search.
  69. The pattern must match an expression in one line.
  70. Patterns are not case sensitive. Only "*" is accepted as a wildcard and no
  71. other constructions like "#?","?" , which noone needs anyway in this application.
  72.  
  73. Use "z ?" for short help.
  74.  
  75. Info
  76. ----
  77. Due to the boyer-moore algorithm the longer the pattern (w/o wildcards)
  78. the shorter the search time.
  79.  
  80. The complete filedescription including filename etc. is searched through.
  81. We, the authors, think that this magic code is the fastest search routine ever
  82. made for an /X like filelist, because the 100% assembler boyer-moore search
  83. routine with pattern matching and highlightning is optimized for cpu cycles by
  84. hand, some magic is done for splitted filedescriptions, asychronous I/O
  85. optimized even for 68040. (cache flushing problem)
  86.  
  87. On our system the bottleneck is the Fast-SCSI-II Baracuda drive with a
  88. Fast-SCSI-II CyberSCSI Controller that does 7MB/s, and the code is 3 times
  89. faster if the filelist is in RAM with 50MB/s burst.
  90.  
  91. The maximum length of a description line allowed is 1000 chars. Since /X
  92. allows 80 chars/line as maximum we think this is no bug. If a line is longer
  93. than 1000 chars enforcer hits may occur. A check for line length would slow
  94. down the code significantly. That`s why we don`t do it.
  95.  
  96. For those who are interested, a short explanation of what "double buffered
  97. async I/O" means:
  98. Due to the coolness of the Amiga, SCSI is the most accepted standard on this
  99. platform (..well if we dont consider 4000 desktops..). SCSI has the ability
  100. to transfer data per DMA, thus meaning without using the processor. This is
  101. were async I/O comes in. A program using double buffered async I/O lets the
  102. filesystem first fill up one buffer, then sends the request to fill up the
  103. second buffer, and while the HD is busy transfering data to the 2nd buffer the
  104. processor is free to do its work on the first one. As you can imagine this
  105. technique dramatically speeds up the whole process.
  106.  
  107. Shell version now included.
  108.  
  109. A pseudo door that calls the door to be debugged is now developed. This way you
  110. can use SAS/C`s debugger cpr easily. If you need it just ask.
  111.  
  112. Send your suggestions or bug reports to crayor@cs.tu-berlin.de or
  113. dres@cs.tu-berlin.de.
  114.  
  115. Reverse search is quite slow, because the seeking in the filelist (which is
  116. even asynchronous) takes 87% of the execution time on Crayor`s system (060&
  117. CyberScsi). Use a cache program like DynamiCache V1.02 by Christopher A. Wolf
  118. with big memory values to make reverse search as fast as forwards search.
  119.  
  120. Maybe a scsi RAID system could be a good solution for reverse searching too,
  121. if you have one please contact Crayor!
  122.  
  123. For the Amiga a "mini raid system" for 2 equal drives is available. If you have
  124. this please contact Crayor. It seems to be software transparent and looks like
  125. just one scsi drive as I was told. This should almost double average transfer
  126. speeds.
  127.  
  128. Memory Requirements
  129. -------------------
  130. Approx. 2*blocksize*100 bytes which is about 100k for load buffers plus 20k
  131. for print buffer plus code size
  132. (blocksize is usually 512 bytes)
  133.  
  134. AmiExpress3.38 needs approx. 200k to run it.
  135.  
  136.  
  137. Shell Version
  138. -------------
  139. The shell version needs a config file with the name
  140. progdir:<executable_name>.config
  141.  
  142. This way you can have several instances of WarpSearch_shell with different
  143. names for your filelist collections.
  144.  
  145. So rename the shell version for example to:
  146.  
  147. TFuckup! and the config file to TFuckup!.config and
  148. DeathRow and the config file to DeathRow.config
  149.  
  150. and you can search in two filelist collections, one for each bbs.
  151.  
  152. Look at the example file "WarpSearch_shell.config" for the construction of
  153. the config files.
  154. Remember that characters like ´+´ have special meanings in the shell so use
  155. " to override these special meanings e.g. "+".
  156. If you hit return while not beeing at a prompt the output will be wired
  157. ofcoz.
  158.  
  159.  
  160. Greetz
  161. ------
  162. Some hellos to the following guys:
  163.  
  164. "Ibo"  - with his always busy or down BBS, so that we weren`t able to abuse
  165.          his BBS for beta testing ;)
  166. Hijack - thx for the cool name of this door m8. (yep! "WarpSearch" actually was
  167.          his idea)
  168. SCSI   - for his help on using iwan.device and other help
  169. Amok   - for the address of Mr.F
  170. STC    - for the competition of coding the fastest search code for /X filelists
  171. Hydra  - for still developing hbbs
  172. Dave Haynie
  173.        - for answering my several emails
  174. The Baron (Mats N.)
  175.        - for reporting the (minor!?) esc-code bug in V2.0 that leeded to V2.1
  176. shadower (M. R. T.)
  177.        - for some good suggestions for V2.1
  178.  
  179. Revision History
  180. ----------------
  181. V1.0 - first public release
  182. V2.0 - second public release
  183. V2.1 - bugfixed V2.0
  184. V2.3 - public r.
  185.  
  186. Looking for good beta testers!
  187.  
  188. Now a MUI version is available. Check the aminet! /comm/amiex
  189.